home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 015a / ed23.zip / ED.DOC next >
Text File  |  1993-04-26  |  16KB  |  397 lines

  1.  
  2.                                ED 2.3
  3.  
  4.                           Full-screen Editor
  5.  
  6.                                   by
  7.  
  8.                                Bob Eyer
  9.                              [73230,2620]
  10.  
  11.                              Apr 26, 1993
  12.  
  13.  
  14.      ┌────────────────────────────────────────────────────────────────┐
  15.      │                                                                │
  16.      │     Advertisement:                                             │
  17.      │                                                                │
  18.      │     Like  the  idea  of a BBS program that works at a basic    │
  19.      │     level with no configuration  at  all--a  miniature  BBS    │
  20.      │     which  can  be  made  as sophisticated as you like, but    │
  21.      │     which can be run as simple utility?  Try HOSP.  Lots of    │
  22.      │     people like it.  And you can have a copy for  $25  (the    │
  23.      │     basic  shareware  charge  plus  $5).  See SHARE.TXT for    │
  24.      │     details.   For preview, see HOST30.ZIP in IBMBBS.          │
  25.      │                                                                │
  26.      └────────────────────────────────────────────────────────────────┘
  27.  
  28.  
  29.  
  30.      Syntax
  31.      ------
  32.  
  33.      ED Filespec [/rows]
  34.  
  35.      Environment
  36.      -----------
  37.      SET ED=xC
  38.       x: color index number
  39.       C: accept external cursor default
  40.  
  41.      F8 key quits
  42.  
  43.  
  44.      Definitions
  45.      -----------
  46.      Filespec       A text file  or wildcard  specifying one or a range
  47.                     of text files.   ED  recognises  all  standard  DOS
  48.                     shortcuts, such as
  49.  
  50.                     ED .  or  ED ..\.
  51.  
  52.                     meaning
  53.  
  54.                     ED *.*  or ED ..\*.*
  55.  
  56.                     or
  57.  
  58.                     ED SYS
  59.  
  60.                     meaning
  61.  
  62.                     ED \SYS\*.*
  63.  
  64.                     ED  accepts  files which have either only the reset
  65.                     attribute or only the archive attribute; all  other
  66.                     combinations  of  attributes  will abort processing
  67.                     with the message "Wrong attribute(s)".
  68.  
  69.                     Selection of a wildcard  causes  ED  to  present  a
  70.                     "select"  window  in  the status line; if you don't
  71.                     like the selection, just hit the F8 key and enter a
  72.                     new wildcard.  Entering a  new  wildcard  does  not
  73.                     erase   the  old  one;  Filespec  is  a  CUMULATIVE
  74.                     wildcard  handler.   (See  discussion   of   Ctrl-N
  75.                     below).
  76.  
  77.                     You  may  move  through  the  resulting  cumulative
  78.                     selection list by using your Up and Dn cursors.
  79.  
  80.                     A  filespec  should   not   be   longer   than   40
  81.                     characters.    ED   allocates  40  bytes  for  each
  82.                     complete filename and allows for a maximum  of  640
  83.                     filenames.
  84.  
  85.                     WARNING:  ED  now  automatically  word-wraps  lines
  86.                     longer  than 80 characters at load time, instead of
  87.                     merely truncating them.   Lines  thus  word-wrapped
  88.                     may  be  recognised by observing which lines in the
  89.                     text are pulled to maximum left  (column  1).   The
  90.                     purpose  of  load-time  word  wrap  is  to  have ED
  91.                     perform the ASCII rectification job which  formerly
  92.                     could  be accomplished only with small editors like
  93.                     Wilmott's SLED.
  94.  
  95.      rows           The maximum  number  of  lines  of  video  display.
  96.                     If not given or if set to *, ED will detect whether
  97.                     the  screen is in 25, 43, or 50 line mode.  If your
  98.                     monitor does not support 43 or 50  line  mode,  the
  99.                     routine  defaults  to 25 lines.  If your monitor is
  100.                     60 line or 44 line, then you must  enter  the  rows
  101.                     parameter explicitly.
  102.  
  103.                     If the status line does not appear at the bottom of
  104.                     your  screen,  the detection routine is not working
  105.                     for  your  monitor  and  manual  override  will  be
  106.                     necessary.
  107.  
  108.                     The  *  entry for rows makes it possible to put the
  109.                     ED  command  line  in   a   batch   file,   without
  110.                     prejudicing  the  question whether your video is in
  111.                     43 or 50 line mode.
  112.  
  113.                     ED does not support 132-column modes.
  114.  
  115.  
  116.      If no parameter is entered on the command  line,  ED  will  simply
  117.      return a simple help screen.
  118.  
  119.  
  120.      Environment
  121.      -----------
  122.      ED sets color and cursor default via the environment.  The general
  123.      syntax is -
  124.  
  125.      SET ED=xC
  126.  
  127.      where x is a color number.  See Colour section below.
  128.  
  129.      If x is not set, the program defaults to 27 (bright cyan on blue).
  130.  
  131.      If  C is added to the ED environment string, ED preserves whatever
  132.      cursor shape was present  prior  to  loading  the  program.   This
  133.      feature  is  useful  primarily to users of block cursors (see CFIX
  134.      program in my SUTL package).  If C is not added to the environment
  135.      string, ED takes action to  define  the  cursor  size  to  be  the
  136.      standard double bottom line.
  137.  
  138.      Example:
  139.  
  140.      SET ED=48C
  141.  
  142.      This string sets ED's colour to be black on cyan background so  as
  143.      to  accept  any  externally defined default for cursor size.  'SET
  144.      ED=48' forces the cursor to be standard.
  145.  
  146.      To remove ED from the environment, use the DOS command
  147.  
  148.      SET ED=
  149.  
  150.      Changes
  151.      -------
  152.      2.2  - Advertising screen replaced with title screen
  153.  
  154.           - Lines automatically wrapped at load time, if longer
  155.             than 80 characters.
  156.  
  157.      2.1  - Advertising screen shifted to avoid flash on single
  158.             element wildcard loads.
  159.  
  160.           - Initial position of wildcard array shifted to agree with
  161.             first element in each new series.
  162.  
  163.           - Standard column feature limited to first 40 positions of
  164.             each line.
  165.  
  166.           - Cursor shape control added to environment (see above).
  167.  
  168.  
  169.      Full Screen Edit
  170.      ----------------
  171.      The  following  is  a  table  showing  the  meaning  of ED's edit
  172.      control   keys.
  173.  
  174.         Key          Meaning
  175.         ------       --------------------------------------------------
  176.         F8           Exit without saving data.
  177.                       The  universal  quit  function was assigned to F8
  178.                       largely as an alternative to using the  Esc  key.
  179.                       The  chief  advantage  of  not  giving functional
  180.                       meaning to the Esc key is to permit the editor to
  181.                       receive    ANSI    escape    sequences    without
  182.                       misinterpreting them.
  183.  
  184.      *  Ctrl-Z       Exit saving data to file.
  185.                       This one is the  'hard  save';  that  is,  Ctrl-Z
  186.                       writes  the  file back to disk regardless whether
  187.                       it was changed in the  editor  (an  unconditional
  188.                       save).
  189.  
  190.      *  Ctrl-N       Load new file or select from a wildcard of files.
  191.                       Will save data to old  file  before  loading  new
  192.                       file, only if there was any attempt to change old
  193.                       data (soft save).
  194.  
  195.                       In  addition, this function does not wipe out the
  196.                       old wildcard previously in  memory;  instead,  it
  197.                       simply  adds  the new wildcard information to the
  198.                       old.  This makes it possible to obtain  full  use
  199.                       of  the  Select  function  F9 in situations where
  200.                       more than one wildcard is needed,  or  where  the
  201.                       files  needed in the Select array are not related
  202.                       to one another by wildcard definition.
  203.  
  204.      *  F9           Present old file list for new select.
  205.                       As does Ctrl-N, this will save data to  old  file
  206.                       before loading any new file, only if the old data
  207.                       were changed (soft save).
  208.  
  209.                      To inject new wildcard, use Ctrl-N.
  210.  
  211.      *  Ctrl-W       Periodically save data during session (AUTO-SAVE).
  212.                       When  activated,  ED automatically saves all data
  213.                       once every three  minutes  on  any  line  change,
  214.                       provided that the data are changed (soft save).
  215.  
  216.         Ctrl-D       Delete current line and put it in the delete
  217.                       buffer.
  218.  
  219.         Ctrl-Y       Insert delete buffer at current line.
  220.  
  221.         Ctrl-L       Insert blank line.
  222.  
  223.         Ctrl-O       Toggle word-wrap status.
  224.                       Default is to enable word-wrap.
  225.  
  226.         Ctrl-I       Set right margin for word-wrap.
  227.                       Default is column 71.  To set, simply move cursor
  228.                       to desired column and then hit Ctrl-I.
  229.  
  230.                       In the event word-wrap is turned off temporarily,
  231.                       ED remembers the previous  right  margin  setting
  232.                       for new Ctrl-O toggle.
  233.  
  234.         F1           Mark first line for cut and paste operations.
  235.                       This function also clears the paste buffer.
  236.  
  237.         F2           Mark last line for cut and paste operations.
  238.                       This  function  also copies all lines between the
  239.                       first and last lines  inclusive  into  the  paste
  240.                       buffer.
  241.  
  242.                       The copy function will not  work  at  all,  where
  243.                       either  the  number of lines to be copied exceeds
  244.                       500 or the number of lines copied plus the number
  245.                       of lines in the file  exceeds  the  RAM  handling
  246.                       capacity  of  the  program (generally, as much as
  247.                       5000-6000 lines).
  248.  
  249.         F3           Cut all text between  the  first  and  last  lines
  250.                      marked, inclusive.
  251.                       The  cut  affects  only  lines to be saved to the
  252.                       input file, not  the  paste  buffer.   Therefore,
  253.                       after  marking  the  desired text with F1 and F2,
  254.                       the user may proceed to cut  and  then  paste  at
  255.                       his desired location.
  256.  
  257.         F4           Paste  all  text  between the first and last lines
  258.                      marked  inclusive  into  current  document  at the
  259.                      position of the cursor.
  260.                       This function can be executed any number of times
  261.                       up  to  available RAM capacity, since ED does not
  262.                       clear the paste buffer except on use  of  the  F1
  263.                       key.
  264.  
  265.         F5           Prompt  for search string, then search from top of
  266.                      file to find first occurrence.  (case insensitive)
  267.  
  268.         F6           Continue to search  for  next  occurrence.
  269.                       After  last  match,  returns  to  prompt  for new
  270.                       search string (uses  previous  search  string  as
  271.                       default   if   none   is   selected).   Since  F6
  272.                       automatically returns to the F5  function  (which
  273.                       begins  searches from the top of the file), there
  274.                       is no need for a reverse search string function.
  275.  
  276.         F7           Split text from cursor to next line.
  277.  
  278.         Up           Previous line.
  279.  
  280.         PgUp         Previous page.
  281.  
  282.         Ctrl-PgUp    Top of file.
  283.  
  284.         Dn           Next line.
  285.  
  286.         PgDn         Next page.
  287.  
  288.         Ctrl-PgDn    Bottom of file.
  289.  
  290.         Right        Move right 1 character.
  291.  
  292.         Left         Move left 1 character.
  293.  
  294.         Tab          Move right 10 characters.
  295.                       Beyond right margin, cursor flips to column 1.
  296.                       [tab stops: 1, 10, 20, 30, 40, 50, 60, 70, 80]
  297.  
  298.         Home         Move cursor to column 1.
  299.  
  300.         End          Move cursor to end of current line.
  301.  
  302.         Ins          Insert mode on/off (default is off)
  303.  
  304.         Backspace    Move left all text right of cursor including
  305.                       cursor ("destructive backspace").
  306.  
  307.         Del          Delete character at cursor position moving
  308.                       remaining characters one position to the left.
  309.  
  310.  
  311.      If you don't wish ED to alter your data file in any  way,  do  not
  312.      use  the  functions  which  are  asterisked  in  the  table above.
  313.  
  314.      Status Line
  315.      -----------
  316.      The status line presents the following data  in  order:  the  file
  317.      name, current line number, column number, insert status, word-wrap
  318.      status,  and  the  system time.  The remainder of the line is used
  319.      for warnings, reminders and transient status messages, such as how
  320.      many lines are in the paste buffer (if any).
  321.  
  322.      Following the Status Line are two lines  of  help,  covering  only
  323.      those keys that may be difficult to remember.
  324.  
  325.      File i/o
  326.      --------
  327.      ED is programmed to suppress the cursor when loading or updating a
  328.      file.
  329.  
  330.      At runtime, ED displays the message
  331.  
  332.      WARNING: File overflow
  333.  
  334.      if the file selected contains more than the line limit or
  335.  
  336.      WARNING: Lines were wrapped
  337.  
  338.      if  the file originally contained lines longer than 80 characters.
  339.      ED 2.2 automatically wraps such lines prior to  display  and  will
  340.      save in wrapped form, unless the user exits via F8.
  341.  
  342.      The  file  overflow  warning  is accompanied by 3 beeps, while the
  343.      line-wrap warning is accompanied by 1 beep.  In  either  of  these
  344.      cases, if you wish to exit without changing the file, you must use
  345.      F8.
  346.  
  347.      Otherwise, where the load is normal, ED displays the message
  348.  
  349.      ^W auto-save
  350.  
  351.      If  you  intend to do any file editing at all, you should activate
  352.      auto-save directly you have the file on screen by hitting  Ctrl-W,
  353.      causing the reminder to be replaced by the message
  354.  
  355.      AUTO-SAVE ON
  356.  
  357.      In the event of an accident you  will  then  lose  at  most  three
  358.      minutes of data changes.
  359.  
  360.      If  no  line  is  changed  when  auto-save  or any other soft save
  361.      function is invoked by  ED,  no  disk  write  will  actually  take
  362.      place.   A  disk  write will always take place, however, on use of
  363.      the hard-save Ctrl-Z function.
  364.  
  365.      Whenever a disk write takes place ED beeps the speaker once.
  366.  
  367.      Colour
  368.      ------
  369.      ED's color default is 27.  But you can  change  it  by  using  the
  370.      table below (see Environment discussion above).
  371.  
  372.                   Back     Fore   Bright Fore
  373.                   ----     ----   -----------
  374.      Black           0        0    8
  375.      Blue           16        1    9
  376.      Green          32        2   10
  377.      Cyan           48        3   11
  378.      Red            64        4   12
  379.      Magenta        80        5   13
  380.      Brown          96        6   14
  381.      White         112        7   15
  382.  
  383.  
  384.      The correct number is found merely by adding the Foreground to the
  385.      Background desired.  For example, Bright Green on Blue  background
  386.      is 10 + 16 = 26.
  387.  
  388.      Avoid  settings  above  127.  Values above that limit will produce
  389.      blinking displays.
  390.  
  391.      In my estimation the numbers best for the eye are 10, 11, 14,  15,
  392.      26,  27,  30,  31, 74, 75, 78, 79 and 112.  But you may have other
  393.      ideas.
  394.  
  395.      -------------------------
  396.      End of documentation
  397.